Back to HMRC Programming Languages Index

Ruby HMRC REST API Examples

Hello World (unrestricted)
Demonstrates the Hello World API unrestricted endpoint. No access token is required for this endpoint.

Hello Application (application-restricted)
Demonstrates the Hello World API "Hello Application" endpoint, which is application-restricted and requires a server_token. (The server token belongs to the "application" you create within your HMRC developer account.)

Submit a VAT Return for a Period
Submits a VAT return for a period. Note: This requires an Authorization header containing an OAuth 2.0 Bearer Token with the write:vat scope. In this example, the "vrn" (VAT registration number) is "123456789" and is a part of the URL.